Skip to content

Improve Mobject.align_data docstring #4152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

irvanalhaq9
Copy link
Contributor

@irvanalhaq9 irvanalhaq9 commented Feb 4, 2025

Overview: What does this pull request change?

  1. Improve .align_data() docstring by adding "family structure" phrase and mentioning internal usage, as well as adding note, examples and See also section
  2. Add related See also section in .become()

Links to added or changed documentation pages

Method align_data: https://manimce--4152.org.readthedocs.build/en/4152/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject.align_data

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

@JasonGrace2282 JasonGrace2282 added the documentation Improvements or additions to documentation label Feb 9, 2025
@irvanalhaq9 irvanalhaq9 force-pushed the improve-align_data-docstring branch 2 times, most recently from a683f4e to 1d3adc0 Compare April 20, 2025 16:12
@irvanalhaq9 irvanalhaq9 force-pushed the improve-align_data-docstring branch from 99e279f to e2e5167 Compare April 20, 2025 16:26
@github-project-automation github-project-automation bot moved this to 🆕 New in Dev Board Apr 20, 2025
Copy link
Contributor

@chopan050 chopan050 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for the changes!

@github-project-automation github-project-automation bot moved this from 🆕 New to 👍 To be merged in Dev Board May 21, 2025
@chopan050 chopan050 enabled auto-merge (squash) May 21, 2025 21:58
@chopan050 chopan050 merged commit ab48557 into ManimCommunity:main May 21, 2025
21 checks passed
@github-project-automation github-project-automation bot moved this from 👍 To be merged to ✅ Done in Dev Board May 21, 2025
@irvanalhaq9 irvanalhaq9 deleted the improve-align_data-docstring branch May 22, 2025 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants